yButton

Description

The yButton is a clickable element with different optical styles, used to indicate its different states. The yButton can be used to trigger a user action. For example:

• Calling a custom JavaScript function
• Hiding and showing popups
• Interacting with yeetClipboards

Basic Structure

In the following the basic structure of the yButton shall be explained. For the general structure of a yComponent please visit the YBase-components basic-structure.

The yButton as seen above contains a label and a icon.

Label

The label contains the text inside the button. It is normally in the center of the component, but can also be displayed on the right or left site. By changing the inner padding of the button, the label gets moved too. You can find further explanation at the Label Property.

Icon

The icon can be used to show an icon inside the yButton. You can have a maximum of two icons in a yButton. The icon can be before or after the text and if you want to have only one yButton with one icon, then you have to delete the text in the Label. You can find further explanation at the Icon Property. An icon is structured as you can see below:

Properties

Through its various properties the yButton can be configured to suit your needs. The display below provides you with an overview of all the yButton properties.

Properties can be changed directly through three methods:

• Inside the Toolbar, which is positioned in your workarea next to your component where you need it. It shows the most important properties, thus providing a fast and efficient way to configure your component in the most basic way.
• It may also occur in the Toolbar Extension, which is a seamless extension accesible as a dropdown item of the Toolbar. It extends the functionality of the Toolbar by providing advanced pickers for most used properties.
• Inside the Detail Panel, which is located in the righthand drawer. Every property of a component can be configured here.

Generic

METAread more

Name: componentId

Not Editable

Number Property

--y-button__component-id

The identifier of the component that is unique within a page.

Name: componentType

Not Editable

String Property

--y-button__component-type

The type of the component. For this component it is -button.

Name: name

String Property

--y-button__name

The custom name of the component. It serves for better identification of the component.

Name: version

String Property

--y-button__version

The custom version of the Button-component. This can be used to ensure that all components work well together.

Name: coreTheme

String Property

--y-button__core-theme

The CoreTheme, which will be apllied to the Button. For further information on themes visit the themes page.

Name: subTheme

String Property

--y-button__sub-theme

The subtheme subordinated to the previously specified CoreTheme, which will be apllied to the Button. For further information on themes visit the themes page.

Name: groupTheme

String Property

--y-button__group-theme

The group theme is a further variation of the subtheme which is specified especially for variations of a component inside the subtheme. For further information on themes visit the Theme-Manager page.

DISPLAYread more

Name: display

String Property

--y-button__display

This property specifies the display behavior of the component. This can be be set to:

• none
• block
• flex
• inline

Name: position

Not Editable

String Property

--y-button__position

This property specifies the type of positioning method used for the component. This can be be set to:

• static
• relative
• absolute
• sticky
• fixed

Name: visible

String Property

--y-button__visible

This property can toggle the visibility of the component. The two modes are completely hidden and fully shown.

SIZEread more

Name: minWidth

Injectable

UnitNumber Property

--y-button__min-width

The minimum value for the width of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %

Name: minHeight

Injectable

UnitNumber Property

--y-button__min-height

The minimum value for the height of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %

Name: width

Injectable

UnitNumber Property

--y-button__width

The value for the width of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• auto

Name: height

Injectable

UnitNumber Property

--y-button__height

The value for the height of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• auto

Name: maxWidth

Injectable

UnitNumber Property

--y-button__max-width

The maximum value for the width of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• none

Name: maxHeight

Injectable

UnitNumber Property

--y-button__max-height

The maximum value for the height of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• none

Name: flex

String Property

--y-button__flex

The flex property sets the length on flexible items. This sets the value in n-fold shares extrapolated to all other components with the flex display within the same container.

PLACEMENTread more

Name: marginTop

Injectable

UnitNumber Property

--y-button__margin-top

This property creates a space around the component, outside of the top border. This can be set in percent or pixels.

Name: marginRight

Injectable

UnitNumber Property

--y-button__margin-right

This property creates a space around the component, outside of the right border. This can be set in percent or pixels.

Name: marginBottom

Injectable

UnitNumber Property

--y-button__margin-bottom

This property creates a space around the component, outside of the bottom border. This can be set in percent or pixels.

Name: marginLeft

Injectable

UnitNumber Property

--y-button__margin-left

This property creates a space around the component, outside of the left border. This can be set in percent or pixels.

Name: paddingTop

Injectable

UnitNumber Property

--y-button__padding-top

This property creates a space within the component, inside of the top border. This can be set in percent or pixels.

Name: paddingRight

Injectable

UnitNumber Property

--y-button__padding-right

This property creates a space within the component, inside of the right border. This can be set in percent or pixels.

Name: paddingBottom

Injectable

UnitNumber Property

--y-button__padding-bottom

This property creates a space within the component, inside of the bottom border. This can be set in percent or pixels.

Name: paddingLeft

Injectable

UnitNumber Property

--y-button__padding-left

This property creates a space within the component, inside of the top border. This can be set in percent or pixels.

Style

BACKGROUNDread more

Name: bgColor

Injectable

Color Property

--y-button__bg-color

--y-button__bg-color__normal

--y-button__bg-color__hover

--y-button__bg-color__focus

--y-button__bg-color__active

--y-button__bg-color__disabled

The color of the background. This can be set as a color from a palette or a custom hex color.

BORDERread more

Name: borderTopColor

Injectable

Color Property

--y-button__border-top-color

--y-button__border-top-color__normal

--y-button__border-top-color__hover

--y-button__border-top-color__focus

--y-button__border-top-color__active

--y-button__border-top-color__disabled

The color of the top border. This can be set as a color from a palette or a custom hex color.

Name: borderTopStyle

Injectable

String Property

--y-button__border-top-style

--y-button__border-top-style__normal

--y-button__border-top-style__hover

--y-button__border-top-style__focus

--y-button__border-top-style__active

--y-button__border-top-style__disabled

The style of the top border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderTopWidth

Injectable

UnitNumber Property

--y-button__border-top-width

--y-button__border-top-width__normal

--y-button__border-top-width__hover

--y-button__border-top-width__focus

--y-button__border-top-width__active

--y-button__border-top-width__disabled

The width of the top border. This can be set in percent or pixels.

Name: borderRightColor

Injectable

Color Property

--y-button__border-right-color

--y-button__border-right-color__normal

--y-button__border-right-color__hover

--y-button__border-right-color__focus

--y-button__border-right-color__active

--y-button__border-right-color__disabled

The color of the right border. This can be set as a color from a palette or a custom hex color.

Name: borderRightStyle

Injectable

String Property

--y-button__border-right-style

--y-button__border-right-style__normal

--y-button__border-right-style__hover

--y-button__border-right-style__focus

--y-button__border-right-style__active

--y-button__border-right-style__disabled

The style of the right border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderRightWidth

Injectable

UnitNumber Property

--y-button__border-right-width

--y-button__border-right-width__normal

--y-button__border-right-width__hover

--y-button__border-right-width__focus

--y-button__border-right-width__active

--y-button__border-right-width__disabled

The width of the right border. This can be set in percent or pixels.

Name: borderBottomColor

Injectable

Color Property

--y-button__border-bottom-color

--y-button__border-bottom-color__normal

--y-button__border-bottom-color__hover

--y-button__border-bottom-color__focus

--y-button__border-bottom-color__active

--y-button__border-bottom-color__disabled

The color of the bottom border. This can be set as a color from a palette or a custom hex color.

Name: borderBottomStyle

Injectable

String Property

--y-button__border-bottom-style

--y-button__border-bottom-style__normal

--y-button__border-bottom-style__hover

--y-button__border-bottom-style__focus

--y-button__border-bottom-style__active

--y-button__border-bottom-style__disabled

The style of the bottom border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderBottomWidth

Injectable

UnitNumber Property

--y-button__border-bottom-width

--y-button__border-bottom-width__normal

--y-button__border-bottom-width__hover

--y-button__border-bottom-width__focus

--y-button__border-bottom-width__active

--y-button__border-bottom-width__disabled

The width of the bottom border. This can be set in percent or pixels.

Name: borderLeftColor

Injectable

Color Property

--y-button__border-left-color

--y-button__border-left-color__normal

--y-button__border-left-color__hover

--y-button__border-left-color__focus

--y-button__border-left-color__active

--y-button__border-left-color__disabled

The color of the left border. This can be set as a color from a palette or a custom hex color.

Name: borderLeftStyle

Injectable

String Property

--y-button__border-left-style

--y-button__border-left-style__normal

--y-button__border-left-style__hover

--y-button__border-left-style__focus

--y-button__border-left-style__active

--y-button__border-left-style__disabled

The style of the left border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderLeftWidth

Injectable

UnitNumber Property

--y-button__border-left-width

--y-button__border-left-width__normal

--y-button__border-left-width__hover

--y-button__border-left-width__focus

--y-button__border-left-width__active

--y-button__border-left-width__disabled

The width of the left border. This can be set in percent or pixels.

Name: borderRadius

Injectable

UnitNumber Property

--y-button__border-radius

The radius of the corners of all the borders. This can be set in percent or pixels.

SHADOWread more

Name: boxShadow

Injectable

String Property

--y-button__box-shadow

--y-button__box-shadow__normal

--y-button__box-shadow__hover

--y-button__box-shadow__focus

--y-button__box-shadow__active

--y-button__box-shadow__disabled

The shadow of the component. This is set by the 4 sub-properties x, y, blur and spread of the shadow-property, which can be further read about in the shadow-property section.

OPACITYread more

Name: opacity

Injectable

Number Property

--y-button__opacity

--y-button__opacity__normal

--y-button__opacity__hover

--y-button__opacity__focus

--y-button__opacity__active

--y-button__opacity__disabled

The opacity of all colored parts of the component. This value is set in percent.

LABELread more

Name: label__fontColor

Injectable

Color Property

--y-button__label__font-color

--y-button__label__font-color__normal

--y-button__label__font-color__hover

--y-button__label__font-color__focus

--y-button__label__font-color__active

--y-button__label__font-color__disabled

The color of the label text. This can be set as a color from a palette or a custom hex color.

Name: label__fontFamily

Injectable

String Property

--y-button__label__font-family

--y-button__label__font-family__normal

--y-button__label__font-family__hover

--y-button__label__font-family__focus

--y-button__label__font-family__active

--y-button__label__font-family__disabled

The font-family of the label text. This can be picked from a large list of provided fonts.

Name: label__fontWeight

Injectable

Number Property

--y-button__label__font-weight

--y-button__label__font-weight__normal

--y-button__label__font-weight__hover

--y-button__label__font-weight__focus

--y-button__label__font-weight__active

--y-button__label__font-weight__disabled

The font-weight of the label text. This can be set in a custom number, as example:

• 400 = normal(regular)
• 500 = medium
• 600 = semi bold
• 700 = bold

Name: label__fontStyle

Injectable

String Property

--y-button__label__font-style

--y-button__label__font-style__normal

--y-button__label__font-style__hover

--y-button__label__font-style__focus

--y-button__label__font-style__active

--y-button__label__font-style__disabled

The font-style of the label text. This can be set to normal, italic or oblique.

Name: label__textTransform

Injectable

String Property

--y-button__label__text-transform

--y-button__label__text-transform__normal

--y-button__label__text-transform__hover

--y-button__label__text-transform__focus

--y-button__label__text-transform__active

--y-button__label__text-transform__disabled

The text-transformation of the label text. This can be set to:

• capitalize
• uppercase
• lowercase
• none
• full-width

Name: label__textDecoration

Injectable

String Property

--y-button__label__text-decoration

--y-button__label__text-decoration__normal

--y-button__label__text-decoration__hover

--y-button__label__text-decoration__focus

--y-button__label__text-decoration__active

--y-button__label__text-decoration__disabled

The text-decoration of the label text. This can be set to:

• strikethrough
• underline

Name: label__fontSize

Injectable

UnitNumber Property

--y-button__label__font-size

The font-size of the label text. This can be set in: -cm

• mm
• in
• px
• em
• ex
• ch
• rem

Name: label__fontAlign

Injectable

String Property

--y-button__label__font-align

The font-align of the label text. This property moves the label text to the desired position, it can be set to left, center or right.

Name: label

String Property

--y-button__label

The actual written text in the label. There is no limit to the number of characters.

ICONread more

Name: iconPosition

String Property

--y-button__icon-position

The position of the icon-element inside the Button-component. This can be set to:

• iconLeft
• iconRight
• iconBoth
• none

Name: icon__colorPrimary

Injectable

Color Property

--y-button__icon__color-primary

--y-button__icon__color-primary__normal

--y-button__icon__color-primary__hover

--y-button__icon__color-primary__active

--y-button__icon__color-primary__focus

--y-button__icon__color-primary__disabled

The primary-color of the icon-element inside the Button-component. This can be set as a color from a palette or a custom hex color.

Name: icon__colorSecondary

Injectable

Color Property

--y-button__icon__color-secondary

--y-button__icon__color-secondary__normal

--y-button__icon__color-secondary__hover

--y-button__icon__color-secondary__active

--y-button__icon__color-secondary__focus

--y-button__icon__color-secondary__disabled

The secondary-color of the icon-element inside the Button-component. This can be set as a color from a palette or a custom hex color.

Name: iconSize

Injectable

UnitNumber Property

--y-button__icon-size

The size of the icon. This can be set in: -cm

• mm
• in
• px

Name: iconLeft

String Property

--y-button__icon-left

The icon to be set as the left icon of the icon-element inside the Button-component.

Name: iconRight

String Property

--y-button__icon-right

The icon to be set as the right icon of the icon-element inside the Button-component.

Button

STATEread more

Name: active

Boolean Property

--y-button__active

This property can disable or enable the active-state of the Button-component.

Name: disabled

Boolean Property

--y-button__disabled

This property can disable or enable the disabled-state of the Button-component.

TOOLTIPread more

Name: tooltip

String Property

--y-button__tooltip

The text of the tooltip, which is displayed when hovering over the Button-component. If you do not insert anything, no tooltip appears.

Name: anchor

String Property

--y-button__anchor

The anchor link that will be displayed inside the tooltip.

Name: self

String Property

--y-button__self

The component itself. ???

MISCread more

Name: toggleMode

Boolean Property

--y-button__toggle-mode

This property can configure the Button-component to cause an emit every click or to be used to set a variable true and false. DELETE

Events

LIFECYCLEread more

Name: EvtInit

String Property

--y-button__-evt-init

This specifies the function to be called, when the Button is initialized.

CONTROLread more

Name: commitCreate

Boolean Property

--y-button__commit-create

If this property is true the Button emits a command to create a new entity instance in the database on click. Clipboard

Name: commitRead

Boolean Property

--y-button__commit-read

If this property is true the Button emits a command to read an entity instance in the database on click.

Name: commitUpdate

Boolean Property

--y-button__commit-update

If this property is true the Button emits a command to update an entity instance in the database on click.

Name: commitDelete

Boolean Property

--y-button__commit-delete

If this property is true the Button emits a command to delete an entity instance in the database on click.

INPUTread more

Name: EvtClicked

String Property

--y-button__-evt-clicked

The event that is triggered when clicking inside the input field.

Usage

In this section you'll find a collection of application scenarios and examples that illustrate how to leverage the yButton in ways that deviate from its standard behavior, as defined by yBase. This section aims to inspire and guide you through various possibilities, helping you to implement more complex or unique functionalities tailored to your specific needs. General properties that are universally applicable can be found in the yBase usage section.

Variations

Elevated

genericarrow_forward_iossizearrow_forward_iosminWidth120px

stylearrow_forward_iosbackgroundarrow_forward_iosbgColor__normal#44ddbb

stylearrow_forward_iosshadowarrow_forward_iosboxShadow__normal0 3px 6px 0 rgba(16, 18, 24, 0.2)

stylearrow_forward_iosborderarrow_forward_iosborderRadius8px

stylearrow_forward_ioslabelarrow_forward_ioslabel__fontColor__normal#FFFFFF

Flat

genericarrow_forward_iossizearrow_forward_iosminWidth120px

stylearrow_forward_iosbackgroundarrow_forward_iosbgColor__normal#44ddbb

stylearrow_forward_iosborderarrow_forward_iosborderRadius8px

stylearrow_forward_ioslabelarrow_forward_ioslabel__fontColor__normal#FFFFFF

Outlined

genericarrow_forward_iossizearrow_forward_iosminWidth120px

stylearrow_forward_iosbackgroundarrow_forward_iosbgColor__normaltransparent

stylearrow_forward_iosborderarrow_forward_iosborderRadius8px

stylearrow_forward_ioslabelarrow_forward_ioslabel__fontColor__normal#44ddbb

stylearrow_forward_iosborderarrow_forward_iosborderStyleTop__normalsolid

stylearrow_forward_iosborderarrow_forward_iosborderStyleRight__normalsolid

stylearrow_forward_iosborderarrow_forward_iosborderStyleBottom__normalsolid

stylearrow_forward_iosborderarrow_forward_iosborderStyleLeft__normalsolid

stylearrow_forward_iosborderarrow_forward_iosborderWidthTop__normal2px

stylearrow_forward_iosborderarrow_forward_iosborderWidthRight__normal2px

stylearrow_forward_iosborderarrow_forward_iosborderWidthBottom__normal2px

stylearrow_forward_iosborderarrow_forward_iosborderWidthLeft__normal2px

stylearrow_forward_iosborderarrow_forward_iosborderColorTop__normal#44ddbb

stylearrow_forward_iosborderarrow_forward_iosborderColorRight__normal#44ddbb

stylearrow_forward_iosborderarrow_forward_iosborderColorBottom__normal#44ddbb

stylearrow_forward_iosborderarrow_forward_iosborderColorLeft__normal#44ddbb

Rounded

genericarrow_forward_iossizearrow_forward_iosminWidth120px

stylearrow_forward_iosbackgroundarrow_forward_iosbgColor__normal#44ddbb

stylearrow_forward_iosshadowarrow_forward_iosboxShadow__normal0 3px 6px 0 rgba(16, 18, 24, 0.2)

stylearrow_forward_iosborderarrow_forward_iosborderRadius20px

stylearrow_forward_ioslabelarrow_forward_ioslabel__fontColor__normal#FFFFFF

Plain

genericarrow_forward_iossizearrow_forward_iosminWidth120px

stylearrow_forward_iosbackgroundarrow_forward_iosbgColor__normaltransparent

stylearrow_forward_iosborderarrow_forward_iosborderRadius8px

stylearrow_forward_ioslabelarrow_forward_ioslabel__fontColor__normal#44ddbb

Label

Uppercase Label

genericarrow_forward_iossizearrow_forward_iosmin-width150px

stylearrow_forward_ioslabelarrow_forward_ioslabel__font-color#FFFFFF

stylearrow_forward_ioslabelarrow_forward_ioslabel__font-family'Roboto'

stylearrow_forward_ioslabelarrow_forward_ioslabel__font-size20px

stylearrow_forward_ioslabelarrow_forward_ioslabel__font-weight'bold'

stylearrow_forward_ioslabelarrow_forward_ioslabel__text-transform'uppercase'

stylearrow_forward_ioslabelarrow_forward_ioslabel'Submit'

Icon

iconLeft

genericarrow_forward_iossizearrow_forward_iosminWidth150px

stylearrow_forward_iosiconarrow_forward_iosiconPosition'iconLeft'

stylearrow_forward_iosiconarrow_forward_iosicon__colorPrimary#FFFFFF

stylearrow_forward_iosiconarrow_forward_iosiconSize16px

stylearrow_forward_iosiconarrow_forward_iosiconLeft'fas-fa-fish'

iconBoth

genericarrow_forward_iossizearrow_forward_iosminWidth150px

stylearrow_forward_iosiconarrow_forward_iosiconPosition'iconBoth'

stylearrow_forward_iosiconarrow_forward_iosicon__colorPrimary#FFFFFF

stylearrow_forward_iosiconarrow_forward_iosiconSize16px

stylearrow_forward_iosiconarrow_forward_iosiconLeft'fas-fa-fish'

stylearrow_forward_iosiconarrow_forward_iosiconRight'fas-fa-fish'

iconOnly

genericarrow_forward_iossizearrow_forward_iosminWidth44px

stylearrow_forward_iosborderarrow_forward_iosborder-radius50%

stylearrow_forward_iosiconarrow_forward_iosiconPosition'iconRight'

stylearrow_forward_iosiconarrow_forward_iosicon__colorPrimary#FFFFFF

stylearrow_forward_iosiconarrow_forward_iosiconSize24px

stylearrow_forward_iosiconarrow_forward_iosiconLeft'fas-fa-fish'

stylearrow_forward_ioslabelarrow_forward_ioslabel'' ''

Calling a custom JavaScript function

The yButton component enables you to execute a custom JavaScript function each time it is clicked.

For instance, you could set up a function that creates a counter on the yButton, incrementing each time the yButton is pressed. Once the counter reaches the number 10, it automatically resets. The steps to achieve this are detailed below.

How to:

1. Open the Detail Panel and proceed to "Events", unfold "Input" to modify "EvtClicked".
2. Associate a custom JavaScript function to the yButton. This function will be invoked every time the yButton is clicked.
3. Include the provided JavaScript snippet below to implement a counter function on the yButton.

Code example:

You can add the following JavaScript code snippet to your application to implement a counter function on the yButton component.

With this script, each click on the yButton will increment the displayed counter until it reaches 10, upon which it will display a congratulatory message and reset. The yButton background color will also change depending on the counters current state.

Button EvtClicked

// function onButton_1_EvtClicked (apiObject, component, eventData) {

let buttonText = component.get("style", "label", "label");
// Convert string to number.
let counter = Number(buttonText);
// Not a number -> reset counter.
if (Number.isNaN(counter)) {
  counter = 0;
  component.set(
    "style",
    "background",
    "bgColor__normal",
    new apiObject.types.colorValue("#22aaffFF")
  );
  component.set(
    "style",
    "background",
    "bgColor__hover",
    new apiObject.types.colorValue("#49B9ffFF")
  );
}
// Increment counter.
else {
  counter++;
}
// Count until ten.
if (counter == 10) {
  buttonText = "Well done!";
  component.set(
    "style",
    "background",
    "bgColor__normal",
    new apiObject.types.colorValue("#00ff0080")
  );
  component.set(
    "style",
    "background",
    "bgColor__hover",
    new apiObject.types.colorValue("#00ff00FF")
  );
} else {
  buttonText = counter.toString();
}
// Log counter value in browser console.
console.log(counter);
// Set property value of button.
component.set("style", "label", "label", buttonText);

// }

Hiding and showing Popups

You can use the yButton to open and close popups.

How to:

1. Navigate to the popup you wish to control and open its Detail Panel.
2. Within these settings, proceed to the "Links" section and select "Open".
3. In this area, use the SourceLink Picker to select the yButton you created earlier. As event choose "click".

And that is it, you can now test this functionality by by entering the preview mode and clicking on the button to observe the popup's visibility change. Visit the popup section, if you want to know more about their behavior.

Interacting with yeetClipboards

You can use the yButton to control Clipboards. The yeetClipboard functionality provides an effective method for managing for example table entries. As example, you can set up a mechanism to delete a table entry by a simple button click.

How to:

1. Open the Detail Panel and proceed to the events tab and locate the "Control" section. Here, you'll need to enable the "Commit-Delete" option. This step empowers the yButton component with the capability to perform this functionality.
2. Create a new Clipboard and enable the "Use Entity" toggle.

3. Then you can click on "Entity-Properties" and edit the "Entity". This Clipboard should be linked to the entity containing the table entry you wish to delete. This way you have to fill in the data, like in the picture below.

4. The _id under "Keys" should be the entry that you wish to delete.
5. Finally, go to the "Events", edit it and select the yButton as SourceLink-1 via the SourceLink Picker. Dont forget that the event has to be "commit-delete".

This will establish a button that, when clicked, will delete the specified entry from your table.

If you want to know more about this topic, visit the Clipboard.